M

AreaLoad.Create

Description:
Creates a new custom area load within the project.

Overloads (3):

Create(Document,ElementId,IList[CurveLoop],IList[XYZ],IList[Int32],IList[Int32],AreaLoadType)

Create(Document,ElementId,IList[CurveLoop],XYZ,AreaLoadType)

Create(Document,ElementId,XYZ,AreaLoadType)

public static AreaLoad Create(
	Document document,
	ElementId hostElemId,
	IList<CurveLoop> loops,
	XYZ forceVector,
	AreaLoadType symbol
)

Public Shared Function Create ( _
	document As Document, _
	hostElemId As ElementId, _
	loops As IList(Of CurveLoop), _
	forceVector As XYZ, _
	symbol As AreaLoadType _
) As AreaLoad

public:
static AreaLoad^ Create(
	Document^ document, 
	ElementId^ hostElemId, 
	IList<CurveLoop^>^ loops, 
	XYZ^ forceVector, 
	AreaLoadType^ symbol
)

Autodesk.Revit.DB.Document

document

Document to which new area load will be added.
Autodesk.Revit.DB.ElementId

hostElemId

The analytical surface host element id for the area Load.
IList<CurveLoop>

loops

The loops that define geometry of the area load. The curve loop collection should contains a closed loops consisting of lines.
Autodesk.Revit.DB.XYZ

forceVector

The force vector applied to the 1st reference point of the area load.
Autodesk.Revit.DB.Structure.AreaLoadType

symbol

The symbol of the AreaLoad. Set nulla null reference (Nothing in Visual Basic) to use default type.

Return Value nullNothingnullptr If successful, returns an object of the newly created AreaLoad. null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.

Autodesk.Revit.Exceptions.ArgumentException

hostElemId is not permitted for this type of load. -or- One of the following requirements is not satisfied : - curve loops loops are not planar - curve loops loops are self-intersecting - curve loops loops contains zero length curves
Autodesk.Revit.Exceptions.ArgumentNullException

A non-optional argument was null
Autodesk.Revit.Exceptions.ArgumentsInconsistentException

Thrown if the host element id is a Curved Panel.
Autodesk.Revit.Exceptions.InvalidOperationException

Thrown if type could not be set for newly created area load.